Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation Page #8

Merged
merged 3 commits into from
Aug 1, 2023
Merged

Documentation Page #8

merged 3 commits into from
Aug 1, 2023

Conversation

kaitj
Copy link
Contributor

@kaitj kaitj commented Jun 29, 2023 •
edited
Loading

Proposed changes

This PR adds a documentation page that the moment generates information based on the docstrings of the code in this repository.

TODO:

  • Update docstrings
  • Fix build status for PRs
  • Fix intersphinx mapping with NumPy

Types of changes
What types of changes does your code introduce? Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Other (if none of the other choices apply)

Checklist
Put an x in the boxes that apply. You can also fill these out after creating the PR. If you are unsure about any of the choices, don't hesitate to ask!

  • Changes have been tested to ensure that fix is effective or that a feature works.
  • Changes pass the unit tests
  • Code has been run through the poe quality task
  • I have included necessary documentation or comments (as necessary)
  • Any dependent changes have been merged and published

Notes
All PRs will undergo the unit testing before being reviewed. You may be requested to explain or make additional changes before the PR is accepted.

@kaitj kaitj added the documentation Improvements or additions to documentation label Jun 29, 2023
@github-actions github-actions bot requested a review from tkkuehn June 29, 2023 19:05
@kaitj kaitj linked an issue Jun 29, 2023 that may be closed by this pull request
[DOC] Create readthedocs #7
Closed
@codecov
Copy link

codecov bot commented Jun 29, 2023 •
edited
Loading

Codecov Report

Merging #8 (c56ac94) into main (0f68fea) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files 
@@            Coverage Diff            @@
##              main        #8   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         6           
  Lines          133       133           
=========================================
  Hits           133       133
Components Coverage Δ
afids_utils/io.py 100.00% <ø> (ø)
afids_utils/transforms.py 100.00% <ø> (ø)

@kaitj kaitj force-pushed the docs/readthedocs branch 3 times, most recently from e4e47d5 to 04f6fa7 Compare June 29, 2023 19:43
@kaitj
init readthedocs
c25700f 
- Set up configuration files
- Set up autodoc to get io and transform modules
- Add badge to documentation on README
@kaitj kaitj force-pushed the docs/readthedocs branch 21 times, most recently from 43ec1cd to 3236d18 Compare June 30, 2023 12:47
@kaitj kaitj changed the title [WIP] Documentation Page Documentation Page Jun 30, 2023
@kaitj kaitj force-pushed the docs/readthedocs branch 2 times, most recently from a2004ab to 769f017 Compare June 30, 2023 17:50
@kaitj
Update docstrings for readthedocs
16f3eac 
- Add numpydoc
- Split submodule pages and add overview page
- Update afids_utils.io
- Update afids_utils.transforms
tkkuehn
tkkuehn requested changes Jul 31, 2023
View reviewed changes
Copy link
Contributor

@tkkuehn tkkuehn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly looks good, just would make the intro a lot more concise.

docs/general/main.md Outdated
@@ -0,0 +1,33 @@
# Overview
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems like a really long section of text mostly describing the purpose of documentation, most of which I don't think we need. I'd keep an adjusted version of the first sentence and maybe add some examples of the kinds of operations we're talking about (or just point to the API docs).

I'd also just move whatever remains to the readme and get rid of this file/section.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think for now I will move the majority of this as a comment to the README until we have time to fully flesh it out in a separate PR.

docs/general/main.md Outdated Show resolved Hide resolved
@kaitj kaitj requested a review from tkkuehn July 31, 2023 15:12
tkkuehn
tkkuehn approved these changes Jul 31, 2023
View reviewed changes
Copy link
Contributor

@tkkuehn tkkuehn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would still prefer to just get rid of general/main.md and put its content in the README, but if you prefer this, that's ok by me and you can go ahead and merge.

@kaitj
Copy link
Contributor Author

kaitj commented Jul 31, 2023 •
edited
Loading

I'm open to that and can make the change in the AM without the examples. Do you want to take another look afterwards?

@kaitj kaitj force-pushed the docs/readthedocs branch 2 times, most recently from 35f86a9 to 2e366ae Compare July 31, 2023 20:53
@kaitj
simplify main doc page
c56ac94 
- Simplify explanation from docs to README (to be fully updated later)
@kaitj kaitj merged commit bbee26b into afids:main Aug 1, 2023
6 checks passed
@kaitj kaitj deleted the docs/readthedocs branch August 1, 2023 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tkkuehn tkkuehn tkkuehn approved these changes

Assignees

@kaitj kaitj

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC] Create readthedocs
2 participants
@kaitj @tkkuehn